DocGenerator fixes #13968
Merged
DocGenerator fixes #13968
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
laurit
reviewed
Jun 3, 2025
| } | ||
|
|
||
| private static String getRepoPath() throws IOException { | ||
| URL resource = DocGeneratorApplication.class.getClassLoader().getResource(""); |
Contributor
There was a problem hiding this comment.
wdyt about passing the root directory from gradle via system property like in
If the system property is not set you could assume that main class was run from intellij and there the current dir is project root.
Member
Author
There was a problem hiding this comment.
i think that is a lot cleaner, thank you for the suggestion
Contributor
There was a problem hiding this comment.
The weird thing about getClassLoader().getResource("") is that afaik not all of the class loaders return anything for it. Here it would be ok, but in a real library it could cause surprises.
laurit
reviewed
Jun 3, 2025
| try (BufferedWriter writer = | ||
| Files.newBufferedWriter( | ||
| Paths.get("docs/instrumentation-list.yaml"), Charset.defaultCharset())) { | ||
| Paths.get(baseRepoPath + "docs/instrumentation-list.yaml"), Charset.defaultCharset())) { |
Contributor
There was a problem hiding this comment.
You really don't need to specify the charset. By default newBufferedWriter uses utf-8 which is what you want. Default charset could be something else.
laurit
approved these changes
Jun 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #13468
I had been running this successfully via an intellij configuration, but the gradle command was not working due to some relative path references. This PR updates the logic to use absolute paths, which fixes the ability to run this via
./gradlew :instrumentation-docs:runAnalysisfrom the repo root.It also fixes an issue where we were only parsing the contents of the first metrics file generated, but some instrumentations generate multiple files. The updated logic will combine all the entries from every file into a single list of metrics and then dedupe them by name.